home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / include / js / jsdbgapi.h < prev    next >
C/C++ Source or Header  |  2006-05-08  |  14KB  |  400 lines
  1. /* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  2.  *
  3.  * ***** BEGIN LICENSE BLOCK *****
  4.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  5.  *
  6.  * The contents of this file are subject to the Mozilla Public License Version
  7.  * 1.1 (the "License"); you may not use this file except in compliance with
  8.  * the License. You may obtain a copy of the License at
  9.  * http://www.mozilla.org/MPL/
  10.  *
  11.  * Software distributed under the License is distributed on an "AS IS" basis,
  12.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13.  * for the specific language governing rights and limitations under the
  14.  * License.
  15.  *
  16.  * The Original Code is Mozilla Communicator client code, released
  17.  * March 31, 1998.
  18.  *
  19.  * The Initial Developer of the Original Code is
  20.  * Netscape Communications Corporation.
  21.  * Portions created by the Initial Developer are Copyright (C) 1998
  22.  * the Initial Developer. All Rights Reserved.
  23.  *
  24.  * Contributor(s):
  25.  *
  26.  * Alternatively, the contents of this file may be used under the terms of
  27.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29.  * in which case the provisions of the GPL or the LGPL are applicable instead
  30.  * of those above. If you wish to allow use of your version of this file only
  31.  * under the terms of either the GPL or the LGPL, and not to allow others to
  32.  * use your version of this file under the terms of the MPL, indicate your
  33.  * decision by deleting the provisions above and replace them with the notice
  34.  * and other provisions required by the GPL or the LGPL. If you do not delete
  35.  * the provisions above, a recipient may use your version of this file under
  36.  * the terms of any one of the MPL, the GPL or the LGPL.
  37.  *
  38.  * ***** END LICENSE BLOCK ***** */
  39.  
  40. #ifndef jsdbgapi_h___
  41. #define jsdbgapi_h___
  42. /*
  43.  * JS debugger API.
  44.  */
  45. #include "jsapi.h"
  46. #include "jsopcode.h"
  47. #include "jsprvtd.h"
  48.  
  49. JS_BEGIN_EXTERN_C
  50.  
  51. extern void
  52. js_PatchOpcode(JSContext *cx, JSScript *script, jsbytecode *pc, JSOp op);
  53.  
  54. extern JS_PUBLIC_API(JSBool)
  55. JS_SetTrap(JSContext *cx, JSScript *script, jsbytecode *pc,
  56.            JSTrapHandler handler, void *closure);
  57.  
  58. extern JS_PUBLIC_API(JSOp)
  59. JS_GetTrapOpcode(JSContext *cx, JSScript *script, jsbytecode *pc);
  60.  
  61. extern JS_PUBLIC_API(void)
  62. JS_ClearTrap(JSContext *cx, JSScript *script, jsbytecode *pc,
  63.              JSTrapHandler *handlerp, void **closurep);
  64.  
  65. extern JS_PUBLIC_API(void)
  66. JS_ClearScriptTraps(JSContext *cx, JSScript *script);
  67.  
  68. extern JS_PUBLIC_API(void)
  69. JS_ClearAllTraps(JSContext *cx);
  70.  
  71. extern JS_PUBLIC_API(JSTrapStatus)
  72. JS_HandleTrap(JSContext *cx, JSScript *script, jsbytecode *pc, jsval *rval);
  73.  
  74. extern JS_PUBLIC_API(JSBool)
  75. JS_SetInterrupt(JSRuntime *rt, JSTrapHandler handler, void *closure);
  76.  
  77. extern JS_PUBLIC_API(JSBool)
  78. JS_ClearInterrupt(JSRuntime *rt, JSTrapHandler *handlerp, void **closurep);
  79.  
  80. /************************************************************************/
  81.  
  82. extern JS_PUBLIC_API(JSBool)
  83. JS_SetWatchPoint(JSContext *cx, JSObject *obj, jsval id,
  84.                  JSWatchPointHandler handler, void *closure);
  85.  
  86. extern JS_PUBLIC_API(JSBool)
  87. JS_ClearWatchPoint(JSContext *cx, JSObject *obj, jsval id,
  88.                    JSWatchPointHandler *handlerp, void **closurep);
  89.  
  90. extern JS_PUBLIC_API(JSBool)
  91. JS_ClearWatchPointsForObject(JSContext *cx, JSObject *obj);
  92.  
  93. extern JS_PUBLIC_API(JSBool)
  94. JS_ClearAllWatchPoints(JSContext *cx);
  95.  
  96. #ifdef JS_HAS_OBJ_WATCHPOINT
  97. /*
  98.  * Hide these non-API function prototypes by testing whether the internal
  99.  * header file "jsconfig.h" has been included.
  100.  */
  101. extern void
  102. js_MarkWatchPoints(JSRuntime *rt);
  103.  
  104. extern JSScopeProperty *
  105. js_FindWatchPoint(JSRuntime *rt, JSScope *scope, jsid id);
  106.  
  107. extern JSPropertyOp
  108. js_GetWatchedSetter(JSRuntime *rt, JSScope *scope,
  109.                     const JSScopeProperty *sprop);
  110.  
  111. extern JSBool JS_DLL_CALLBACK
  112. js_watch_set(JSContext *cx, JSObject *obj, jsval id, jsval *vp);
  113.  
  114. extern JSBool JS_DLL_CALLBACK
  115. js_watch_set_wrapper(JSContext *cx, JSObject *obj, uintN argc, jsval *argv,
  116.                      jsval *rval);
  117.  
  118. extern JSPropertyOp
  119. js_WrapWatchedSetter(JSContext *cx, jsid id, uintN attrs, JSPropertyOp setter);
  120.  
  121. #endif /* JS_HAS_OBJ_WATCHPOINT */
  122.  
  123. /************************************************************************/
  124.  
  125. extern JS_PUBLIC_API(uintN)
  126. JS_PCToLineNumber(JSContext *cx, JSScript *script, jsbytecode *pc);
  127.  
  128. extern JS_PUBLIC_API(jsbytecode *)
  129. JS_LineNumberToPC(JSContext *cx, JSScript *script, uintN lineno);
  130.  
  131. extern JS_PUBLIC_API(JSScript *)
  132. JS_GetFunctionScript(JSContext *cx, JSFunction *fun);
  133.  
  134. extern JS_PUBLIC_API(JSNative)
  135. JS_GetFunctionNative(JSContext *cx, JSFunction *fun);
  136.  
  137. extern JS_PUBLIC_API(JSPrincipals *)
  138. JS_GetScriptPrincipals(JSContext *cx, JSScript *script);
  139.  
  140. /*
  141.  * Stack Frame Iterator
  142.  *
  143.  * Used to iterate through the JS stack frames to extract
  144.  * information from the frames.
  145.  */
  146.  
  147. extern JS_PUBLIC_API(JSStackFrame *)
  148. JS_FrameIterator(JSContext *cx, JSStackFrame **iteratorp);
  149.  
  150. extern JS_PUBLIC_API(JSScript *)
  151. JS_GetFrameScript(JSContext *cx, JSStackFrame *fp);
  152.  
  153. extern JS_PUBLIC_API(jsbytecode *)
  154. JS_GetFramePC(JSContext *cx, JSStackFrame *fp);
  155.  
  156. /*
  157.  * Get the closest scripted frame below fp.  If fp is null, start from cx->fp.
  158.  */
  159. extern JS_PUBLIC_API(JSStackFrame *)
  160. JS_GetScriptedCaller(JSContext *cx, JSStackFrame *fp);
  161.  
  162. /*
  163.  * Return a weak reference to fp's principals.  A null return does not denote
  164.  * an error, it means there are no principals.
  165.  */
  166. extern JS_PUBLIC_API(JSPrincipals *)
  167. JS_StackFramePrincipals(JSContext *cx, JSStackFrame *fp);
  168.  
  169. /*
  170.  * This API is like JS_StackFramePrincipals(cx, caller), except that if
  171.  * cx->runtime->findObjectPrincipals is non-null, it returns the weaker of
  172.  * the caller's principals and the object principals of fp's callee function
  173.  * object (fp->argv[-2]), which is eval, Function, or a similar eval-like
  174.  * method.  The caller parameter should be JS_GetScriptedCaller(cx, fp).
  175.  *
  176.  * All eval-like methods must use JS_EvalFramePrincipals to acquire a weak
  177.  * reference to the correct principals for the eval call to be secure, given
  178.  * an embedding that calls JS_SetObjectPrincipalsFinder (see jsapi.h).
  179.  */
  180. extern JS_PUBLIC_API(JSPrincipals *)
  181. JS_EvalFramePrincipals(JSContext *cx, JSStackFrame *fp, JSStackFrame *caller);
  182.  
  183. extern JS_PUBLIC_API(void *)
  184. JS_GetFrameAnnotation(JSContext *cx, JSStackFrame *fp);
  185.  
  186. extern JS_PUBLIC_API(void)
  187. JS_SetFrameAnnotation(JSContext *cx, JSStackFrame *fp, void *annotation);
  188.  
  189. extern JS_PUBLIC_API(void *)
  190. JS_GetFramePrincipalArray(JSContext *cx, JSStackFrame *fp);
  191.  
  192. extern JS_PUBLIC_API(JSBool)
  193. JS_IsNativeFrame(JSContext *cx, JSStackFrame *fp);
  194.  
  195. /* this is deprecated, use JS_GetFrameScopeChain instead */
  196. extern JS_PUBLIC_API(JSObject *)
  197. JS_GetFrameObject(JSContext *cx, JSStackFrame *fp);
  198.  
  199. extern JS_PUBLIC_API(JSObject *)
  200. JS_GetFrameScopeChain(JSContext *cx, JSStackFrame *fp);
  201.  
  202. extern JS_PUBLIC_API(JSObject *)
  203. JS_GetFrameCallObject(JSContext *cx, JSStackFrame *fp);
  204.  
  205. extern JS_PUBLIC_API(JSObject *)
  206. JS_GetFrameThis(JSContext *cx, JSStackFrame *fp);
  207.  
  208. extern JS_PUBLIC_API(JSFunction *)
  209. JS_GetFrameFunction(JSContext *cx, JSStackFrame *fp);
  210.  
  211. extern JS_PUBLIC_API(JSObject *)
  212. JS_GetFrameFunctionObject(JSContext *cx, JSStackFrame *fp);
  213.  
  214. /* XXXrginda Initially published with typo */
  215. #define JS_IsContructorFrame JS_IsConstructorFrame
  216. extern JS_PUBLIC_API(JSBool)
  217. JS_IsConstructorFrame(JSContext *cx, JSStackFrame *fp);
  218.  
  219. extern JS_PUBLIC_API(JSBool)
  220. JS_IsDebuggerFrame(JSContext *cx, JSStackFrame *fp);
  221.  
  222. extern JS_PUBLIC_API(jsval)
  223. JS_GetFrameReturnValue(JSContext *cx, JSStackFrame *fp);
  224.  
  225. extern JS_PUBLIC_API(void)
  226. JS_SetFrameReturnValue(JSContext *cx, JSStackFrame *fp, jsval rval);
  227.  
  228. /**
  229.  * Return fp's callee function object (fp->argv[-2]) if it has one.
  230.  */
  231. extern JS_PUBLIC_API(JSObject *)
  232. JS_GetFrameCalleeObject(JSContext *cx, JSStackFrame *fp);
  233.  
  234. /************************************************************************/
  235.  
  236. extern JS_PUBLIC_API(const char *)
  237. JS_GetScriptFilename(JSContext *cx, JSScript *script);
  238.  
  239. extern JS_PUBLIC_API(uintN)
  240. JS_GetScriptBaseLineNumber(JSContext *cx, JSScript *script);
  241.  
  242. extern JS_PUBLIC_API(uintN)
  243. JS_GetScriptLineExtent(JSContext *cx, JSScript *script);
  244.  
  245. extern JS_PUBLIC_API(JSVersion)
  246. JS_GetScriptVersion(JSContext *cx, JSScript *script);
  247.  
  248. /************************************************************************/
  249.  
  250. /*
  251.  * Hook setters for script creation and destruction, see jsprvtd.h for the
  252.  * typedefs.  These macros provide binary compatibility and newer, shorter
  253.  * synonyms.
  254.  */
  255. #define JS_SetNewScriptHook     JS_SetNewScriptHookProc
  256. #define JS_SetDestroyScriptHook JS_SetDestroyScriptHookProc
  257.  
  258. extern JS_PUBLIC_API(void)
  259. JS_SetNewScriptHook(JSRuntime *rt, JSNewScriptHook hook, void *callerdata);
  260.  
  261. extern JS_PUBLIC_API(void)
  262. JS_SetDestroyScriptHook(JSRuntime *rt, JSDestroyScriptHook hook,
  263.                         void *callerdata);
  264.  
  265. /************************************************************************/
  266.  
  267. extern JS_PUBLIC_API(JSBool)
  268. JS_EvaluateUCInStackFrame(JSContext *cx, JSStackFrame *fp,
  269.                           const jschar *bytes, uintN length,
  270.                           const char *filename, uintN lineno,
  271.                           jsval *rval);
  272.  
  273. extern JS_PUBLIC_API(JSBool)
  274. JS_EvaluateInStackFrame(JSContext *cx, JSStackFrame *fp,
  275.                         const char *bytes, uintN length,
  276.                         const char *filename, uintN lineno,
  277.                         jsval *rval);
  278.  
  279. /************************************************************************/
  280.  
  281. typedef struct JSPropertyDesc {
  282.     jsval           id;         /* primary id, a string or int */
  283.     jsval           value;      /* property value */
  284.     uint8           flags;      /* flags, see below */
  285.     uint8           spare;      /* unused */
  286.     uint16          slot;       /* argument/variable slot */
  287.     jsval           alias;      /* alias id if JSPD_ALIAS flag */
  288. } JSPropertyDesc;
  289.  
  290. #define JSPD_ENUMERATE  0x01    /* visible to for/in loop */
  291. #define JSPD_READONLY   0x02    /* assignment is error */
  292. #define JSPD_PERMANENT  0x04    /* property cannot be deleted */
  293. #define JSPD_ALIAS      0x08    /* property has an alias id */
  294. #define JSPD_ARGUMENT   0x10    /* argument to function */
  295. #define JSPD_VARIABLE   0x20    /* local variable in function */
  296. #define JSPD_EXCEPTION  0x40    /* exception occurred fetching the property, */
  297.                                 /* value is exception */
  298. #define JSPD_ERROR      0x80    /* native getter returned JS_FALSE without */
  299.                                 /* throwing an exception */
  300.  
  301. typedef struct JSPropertyDescArray {
  302.     uint32          length;     /* number of elements in array */
  303.     JSPropertyDesc  *array;     /* alloc'd by Get, freed by Put */
  304. } JSPropertyDescArray;
  305.  
  306. extern JS_PUBLIC_API(JSScopeProperty *)
  307. JS_PropertyIterator(JSObject *obj, JSScopeProperty **iteratorp);
  308.  
  309. extern JS_PUBLIC_API(JSBool)
  310. JS_GetPropertyDesc(JSContext *cx, JSObject *obj, JSScopeProperty *sprop,
  311.                    JSPropertyDesc *pd);
  312.  
  313. extern JS_PUBLIC_API(JSBool)
  314. JS_GetPropertyDescArray(JSContext *cx, JSObject *obj, JSPropertyDescArray *pda);
  315.  
  316. extern JS_PUBLIC_API(void)
  317. JS_PutPropertyDescArray(JSContext *cx, JSPropertyDescArray *pda);
  318.  
  319. /************************************************************************/
  320.  
  321. extern JS_PUBLIC_API(JSBool)
  322. JS_SetDebuggerHandler(JSRuntime *rt, JSTrapHandler handler, void *closure);
  323.  
  324. extern JS_PUBLIC_API(JSBool)
  325. JS_SetSourceHandler(JSRuntime *rt, JSSourceHandler handler, void *closure);
  326.  
  327. extern JS_PUBLIC_API(JSBool)
  328. JS_SetExecuteHook(JSRuntime *rt, JSInterpreterHook hook, void *closure);
  329.  
  330. extern JS_PUBLIC_API(JSBool)
  331. JS_SetCallHook(JSRuntime *rt, JSInterpreterHook hook, void *closure);
  332.  
  333. extern JS_PUBLIC_API(JSBool)
  334. JS_SetObjectHook(JSRuntime *rt, JSObjectHook hook, void *closure);
  335.  
  336. extern JS_PUBLIC_API(JSBool)
  337. JS_SetThrowHook(JSRuntime *rt, JSTrapHandler hook, void *closure);
  338.  
  339. extern JS_PUBLIC_API(JSBool)
  340. JS_SetDebugErrorHook(JSRuntime *rt, JSDebugErrorHook hook, void *closure);
  341.  
  342. /************************************************************************/
  343.  
  344. extern JS_PUBLIC_API(size_t)
  345. JS_GetObjectTotalSize(JSContext *cx, JSObject *obj);
  346.  
  347. extern JS_PUBLIC_API(size_t)
  348. JS_GetFunctionTotalSize(JSContext *cx, JSFunction *fun);
  349.  
  350. extern JS_PUBLIC_API(size_t)
  351. JS_GetScriptTotalSize(JSContext *cx, JSScript *script);
  352.  
  353. /*
  354.  * Get the top-most running script on cx starting from fp, or from the top of
  355.  * cx's frame stack if fp is null, and return its script filename flags.  If
  356.  * the script has a null filename member, return JSFILENAME_NULL.
  357.  */
  358. extern JS_PUBLIC_API(uint32)
  359. JS_GetTopScriptFilenameFlags(JSContext *cx, JSStackFrame *fp);
  360.  
  361. /*
  362.  * Associate flags with a script filename prefix in rt, so that any subsequent
  363.  * script compilation will inherit those flags if the script's filename is the
  364.  * same as prefix, or if prefix is a substring of the script's filename.
  365.  *
  366.  * The API defines only one flag bit, JSFILENAME_SYSTEM, leaving the remaining
  367.  * 31 bits up to the API client to define.  The union of all 32 bits must not
  368.  * be a legal combination, however, in order to preserve JSFILENAME_NULL as a
  369.  * unique value.  API clients may depend on JSFILENAME_SYSTEM being a set bit
  370.  * in JSFILENAME_NULL -- a script with a null filename member is presumed to
  371.  * be a "system" script.
  372.  */
  373. extern JS_PUBLIC_API(JSBool)
  374. JS_FlagScriptFilenamePrefix(JSRuntime *rt, const char *prefix, uint32 flags);
  375.  
  376. #define JSFILENAME_NULL         0xffffffff      /* null script filename */
  377. #define JSFILENAME_SYSTEM       0x00000001      /* "system" script, see below */
  378.  
  379. /*
  380.  * Return true if obj is a "system" object, that is, one flagged by a prior
  381.  * call to JS_FlagSystemObject(cx, obj).  What "system" means is up to the API
  382.  * client, but it can be used to coordinate access control policies based on
  383.  * script filenames and their prefixes, using JS_FlagScriptFilenamePrefix and
  384.  * JS_GetTopScriptFilenameFlags.
  385.  */
  386. extern JS_PUBLIC_API(JSBool)
  387. JS_IsSystemObject(JSContext *cx, JSObject *obj);
  388.  
  389. /*
  390.  * Flag obj as a "system" object.  The API client can flag system objects to
  391.  * optimize access control checks.  The engine stores but does not interpret
  392.  * the per-object flag set by this call.
  393.  */
  394. extern JS_PUBLIC_API(void)
  395. JS_FlagSystemObject(JSContext *cx, JSObject *obj);
  396.  
  397. JS_END_EXTERN_C
  398.  
  399. #endif /* jsdbgapi_h___ */
  400.